Class ICMPSignatureImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ICMPSignatureImpl
All Implemented Interfaces:
IPCObject, ICMPSignature

public class ICMPSignatureImpl extends IPCObjectImpl implements ICMPSignature
Information provided by the PKI file:

    \class IcmpSignature
    
    \brief IcmpSignature handles and manipulates ICMP signatures.
    
    \example network().getDevice("Router0").getProcess("IpsProcess").getIcmpSignature()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getSigId

      public int getSigId()
      Information provided by the PKI file:
      
          \brief Returns the signature ID.
          
          \return int, the signature ID.
          
              
      Specified by:
      getSigId in interface ICMPSignature
      Returns:
      int Returns a int
    • getSubId

      public int getSubId()
      Information provided by the PKI file:
      
          \brief Returns the signature sub-id.
          
          \return int, the signature sub-id.
          
              
      Specified by:
      getSubId in interface ICMPSignature
      Returns:
      int Returns a int
    • getRetired

      public boolean getRetired()
      Information provided by the PKI file:
      
          \brief Returns the retired value for the ICMP signature.
          
          \return Bool,       the retired value.
          Retired values:     eDefault = 0,
          eFalse = 1,
          eTrue = 2
          
              
      Specified by:
      getRetired in interface ICMPSignature
      Returns:
      boolean Returns a boolean
    • getEnabled

      public boolean getEnabled()
      Information provided by the PKI file:
      
          \brief Returns the enabled value.
          
          \return Bool,       the enabled value.
          Enabled values:     eDefault = 0,
          eFalse = 1,
          eTrue = 2
          
              
      Specified by:
      getEnabled in interface ICMPSignature
      Returns:
      boolean Returns a boolean
    • getEventActionCount

      public int getEventActionCount()
      Information provided by the PKI file:
      
          \brief Returns the event action count.
          
          \return int, the event action count.
          
              
      Specified by:
      getEventActionCount in interface ICMPSignature
      Returns:
      int Returns a int
    • getEventActionAt

      public SigEventAction getEventActionAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the event action at the specified index.
          
          \param index, the index of the event action of interest.
          
          \return SigEventAction,     the event action at the specified index.
          Event actions:      eInvalid = -1,
          eProduceAlert = 0,
          eDenyPacketInline = 1,
          eDenyAttackerInline = 2,
          eDenyConnInline = 3,
          eRstTCPConn = 4,
          
              
      Specified by:
      getEventActionAt in interface ICMPSignature
      Parameters:
      index - Takes in a parameter of index
      Returns:
      SigEventAction Returns a SigEventAction
    • setRetired

      public void setRetired(boolean val)
      Information provided by the PKI file:
      
          \brief Sets the retired value.
          
          \param Bool,        the retired value.
          Retired values:     eDefault = 0,
          eFalse = 1,
          eTrue = 2
          
              
      Specified by:
      setRetired in interface ICMPSignature
      Parameters:
      val - Takes in a parameter of val
    • setEnabled

      public void setEnabled(boolean val)
      Information provided by the PKI file:
      
          \brief Sets the enabled value.
          
          \param Bool,        the enable value.
          Enabled values:     eDefault = 0,
          eFalse = 1,
          eTrue = 2
          
              
      Specified by:
      setEnabled in interface ICMPSignature
      Parameters:
      val - Takes in a parameter of val
    • setEventAction

      public void setEventAction(SigEventAction eAction)
      Information provided by the PKI file:
      
          \brief Sets the event action for the ICMP signature.
          
          \param eAction,     the event action at the specified index.
          Event actions:      eInvalid = -1,
          eProduceAlert = 0,
          eDenyPacketInline = 1,
          eDenyAttackerInline = 2,
          eDenyConnInline = 3,
          eRstTCPConn = 4,
          
              
      Specified by:
      setEventAction in interface ICMPSignature
      Parameters:
      eAction - Takes in a parameter of eAction